CreateEmailAddress

The CreateEmailAddress web serviceClosed XML- or JSON-based information exchange systems that use the Internet for direct application-to-application interaction. These systems can include programs, objects, messages, or documents. enables an external client system to create an email address at any level of the CMPClosed Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. hierarchy.

This service should be used in conjunction with the following services (to obtain the current primary email address):

The userClosed A person with the capability to log in to the CMP GUI software, such as a customer service advisor or agent. must pass an identifier for the appropriate level of the hierarchy at which the new email address should be created, along with the email address type. In addition, the user is able to set the new email address as their primary email address.

CreateEmailAddress Request

The CreateEmailAddress tag instructs the Address Service to create an email address. This request contains the following elements:

Element Name

Content Type

Description

Required?

EmailData

Container

See EmailData Request Container for details.

Mandatory

EmailData Request Container

The EmailData request container holds details of email data. It has the following elements:

Element Name

Content Type

Description

Required?

ExternalReference

String69

The client may use this identifier to correlate the request and the response.

Optional

EmailAddress

String70

This adds an e mail address with the default email address type. The default e-mail address type is defined in setup. The email address entered must be a validly formatted email address.

Mandatory

PrimaryEmailAddress

Boolean

Indicates whether this is to be the primary email address or not.

Mandatory

TargetIdentifier

Container - Choice

Choice of:

  • Group Identifier (String6)
  • Corporate Identifier (String6)
  • Account Identifier (Integer8)
  • Subscription Identifier (Integer8)

Mandatory

EmailAddressType

String6

The types and the default email type can be defined via setup. The Email Type supplied must be a valid email type as defined via setup.

Mandatory

AuditRecord

Container

See AuditRecord Request Container for details.

Optional

AuditRecord Request Container

The AuditRecord request container has the following elements:

Element Name

Content Type

Description

Required?

UserID

String10

If specified, this will override the default User ID used when creating records as a result of this webservice.

Mandatory

Program

String10

If specified, this will override the default Program used when creating records as a result of this webservice.

Mandatory

CreateEmailAddress Response

CreateEmailAddress response is the response to the CreateEmailAddress Request. This contains the following elements:

Element Name

Content Type

Description

Required?

ExternalReference

String69

Returned unmodified in the response. The client may use this identifier to correlate the request and the response.

Optional